File: C:/Ruby27-x64/share/doc/ruby/html/RDoc/Mixin.html
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>class RDoc::Mixin - RDoc Documentation</title>
<script type="text/javascript">
var rdoc_rel_prefix = "../";
var index_rel_prefix = "../";
</script>
<script src="../js/navigation.js" defer></script>
<script src="../js/search.js" defer></script>
<script src="../js/search_index.js" defer></script>
<script src="../js/searcher.js" defer></script>
<script src="../js/darkfish.js" defer></script>
<link href="../css/fonts.css" rel="stylesheet">
<link href="../css/rdoc.css" rel="stylesheet">
<body id="top" role="document" class="class">
<nav role="navigation">
<div id="project-navigation">
<div id="home-section" role="region" title="Quick navigation" class="nav-section">
<h2>
<a href="../index.html" rel="home">Home</a>
</h2>
<div id="table-of-contents-navigation">
<a href="../table_of_contents.html#pages">Pages</a>
<a href="../table_of_contents.html#classes">Classes</a>
<a href="../table_of_contents.html#methods">Methods</a>
</div>
</div>
<div id="search-section" role="search" class="project-section initially-hidden">
<form action="#" method="get" accept-charset="utf-8">
<div id="search-field-wrapper">
<input id="search-field" role="combobox" aria-label="Search"
aria-autocomplete="list" aria-controls="search-results"
type="text" name="search" placeholder="Search" spellcheck="false"
title="Type to search, Up and Down to navigate, Enter to load">
</div>
<ul id="search-results" aria-label="Search Results"
aria-busy="false" aria-expanded="false"
aria-atomic="false" class="initially-hidden"></ul>
</form>
</div>
</div>
<div id="class-metadata">
<div id="parent-class-section" class="nav-section">
<h3>Parent</h3>
<p class="link"><a href="CodeObject.html">RDoc::CodeObject</a>
</div>
<!-- Method Quickref -->
<div id="method-list-section" class="nav-section">
<h3>Methods</h3>
<ul class="link-list" role="directory">
<li class="calls-super" ><a href="#method-c-new">::new</a>
<li ><a href="#method-i-3C-3D-3E">#<=></a>
<li ><a href="#method-i-full_name">#full_name</a>
<li ><a href="#method-i-module">#module</a>
<li class="calls-super" ><a href="#method-i-store-3D">#store=</a>
</ul>
</div>
</div>
</nav>
<main role="main" aria-labelledby="class-RDoc::Mixin">
<h1 id="class-RDoc::Mixin" class="class">
class RDoc::Mixin
</h1>
<section class="description">
<p>A <a href="Mixin.html"><code>Mixin</code></a> adds features from a module into another context. <a href="Include.html"><code>RDoc::Include</code></a> and <a href="Extend.html"><code>RDoc::Extend</code></a> are both mixins.</p>
</section>
<section id="5Buntitled-5D" class="documentation-section">
<section class="attribute-method-details" class="method-section">
<header>
<h3>Attributes</h3>
</header>
<div id="attribute-i-name" class="method-detail">
<div class="method-heading attribute-method-heading">
<span class="method-name">name</span><span
class="attribute-access-type">[RW]</span>
</div>
<div class="method-description">
<p>Name of included module</p>
</div>
</div>
</section>
<section id="public-class-5Buntitled-5D-method-details" class="method-section">
<header>
<h3>Public Class Methods</h3>
</header>
<div id="method-c-new" class="method-detail ">
<div class="method-heading">
<span class="method-name">new</span><span
class="method-args">(name, comment)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Creates a new <a href="Mixin.html"><code>Mixin</code></a> for <code>name</code> with <code>comment</code></p>
<div class="method-calls-super">
Calls superclass method
<a href="CodeObject.html#method-c-new"><code>RDoc::CodeObject::new</code></a>
</div>
<div class="method-source-code" id="new-source">
<pre><span class="ruby-comment"># File lib/rdoc/mixin.rb, line 16</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span>(<span class="ruby-identifier">name</span>, <span class="ruby-identifier">comment</span>)
<span class="ruby-keyword">super</span>()
<span class="ruby-ivar">@name</span> = <span class="ruby-identifier">name</span>
<span class="ruby-keyword">self</span>.<span class="ruby-identifier">comment</span> = <span class="ruby-identifier">comment</span>
<span class="ruby-ivar">@module</span> = <span class="ruby-keyword">nil</span> <span class="ruby-comment"># cache for module if found</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
</section>
<section id="public-instance-5Buntitled-5D-method-details" class="method-section">
<header>
<h3>Public Instance Methods</h3>
</header>
<div id="method-i-3C-3D-3E" class="method-detail ">
<div class="method-heading">
<span class="method-name"><=></span><span
class="method-args">(other)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Mixins are sorted by name</p>
<div class="method-source-code" id="3C-3D-3E-source">
<pre><span class="ruby-comment"># File lib/rdoc/mixin.rb, line 26</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title"><=></span> <span class="ruby-identifier">other</span>
<span class="ruby-keyword">return</span> <span class="ruby-keyword">unless</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">class</span> <span class="ruby-operator">===</span> <span class="ruby-identifier">other</span>
<span class="ruby-identifier">name</span> <span class="ruby-operator"><=></span> <span class="ruby-identifier">other</span>.<span class="ruby-identifier">name</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-full_name" class="method-detail ">
<div class="method-heading">
<span class="method-name">full_name</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Full name based on <a href="Mixin.html#method-i-module"><code>module</code></a></p>
<div class="method-source-code" id="full_name-source">
<pre><span class="ruby-comment"># File lib/rdoc/mixin.rb, line 41</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">full_name</span>
<span class="ruby-identifier">m</span> = <span class="ruby-keyword">self</span>.<span class="ruby-identifier">module</span>
<span class="ruby-constant">RDoc</span><span class="ruby-operator">::</span><span class="ruby-constant">ClassModule</span> <span class="ruby-operator">===</span> <span class="ruby-identifier">m</span> <span class="ruby-operator">?</span> <span class="ruby-identifier">m</span>.<span class="ruby-identifier">full_name</span> <span class="ruby-operator">:</span> <span class="ruby-ivar">@name</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-module" class="method-detail ">
<div class="method-heading">
<span class="method-name">module</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Attempts to locate the included module object. Returns the name if not known.</p>
<p>The scoping rules of Ruby to resolve the name of an included module are:</p>
<ul><li>
<p>first look into the children of the current context;</p>
</li><li>
<p>if not found, look into the children of included modules, in reverse inclusion order;</p>
</li><li>
<p>if still not found, go up the hierarchy of names.</p>
</li></ul>
<p>This method has <code>O(n!)</code> behavior when the module calling include is referencing nonexistent modules. Avoid calling <a href="Mixin.html#method-i-module"><code>module</code></a> until after all the files are parsed. This behavior is due to ruby's constant lookup behavior.</p>
<p>As of the beginning of October, 2011, no gem includes nonexistent modules.</p>
<div class="method-source-code" id="module-source">
<pre><span class="ruby-comment"># File lib/rdoc/mixin.rb, line 75</span>
<span class="ruby-keyword">def</span> <span class="ruby-keyword">module</span>
<span class="ruby-keyword">return</span> <span class="ruby-ivar">@module</span> <span class="ruby-keyword">if</span> <span class="ruby-ivar">@module</span>
<span class="ruby-comment"># search the current context</span>
<span class="ruby-keyword">return</span> <span class="ruby-ivar">@name</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier ruby-title">parent</span>
<span class="ruby-identifier">full_name</span> = <span class="ruby-identifier">parent</span>.<span class="ruby-identifier">child_name</span>(<span class="ruby-ivar">@name</span>)
<span class="ruby-ivar">@module</span> = <span class="ruby-ivar">@store</span>.<span class="ruby-identifier">modules_hash</span>[<span class="ruby-identifier">full_name</span>]
<span class="ruby-keyword">return</span> <span class="ruby-ivar">@module</span> <span class="ruby-keyword">if</span> <span class="ruby-ivar">@module</span>
<span class="ruby-keyword">return</span> <span class="ruby-ivar">@name</span> <span class="ruby-keyword">if</span> <span class="ruby-ivar">@name</span> <span class="ruby-operator">=~</span> <span class="ruby-regexp">/^::/</span>
<span class="ruby-comment"># search the includes before this one, in reverse order</span>
<span class="ruby-identifier">searched</span> = <span class="ruby-identifier">parent</span>.<span class="ruby-identifier">includes</span>.<span class="ruby-identifier">take_while</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">i</span><span class="ruby-operator">|</span> <span class="ruby-identifier">i</span> <span class="ruby-operator">!=</span> <span class="ruby-keyword">self</span> }.<span class="ruby-identifier">reverse</span>
<span class="ruby-identifier">searched</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">i</span><span class="ruby-operator">|</span>
<span class="ruby-identifier">inc</span> = <span class="ruby-identifier">i</span>.<span class="ruby-identifier">module</span>
<span class="ruby-keyword">next</span> <span class="ruby-keyword">if</span> <span class="ruby-constant">String</span> <span class="ruby-operator">===</span> <span class="ruby-identifier">inc</span>
<span class="ruby-identifier">full_name</span> = <span class="ruby-identifier">inc</span>.<span class="ruby-identifier">child_name</span>(<span class="ruby-ivar">@name</span>)
<span class="ruby-ivar">@module</span> = <span class="ruby-ivar">@store</span>.<span class="ruby-identifier">modules_hash</span>[<span class="ruby-identifier">full_name</span>]
<span class="ruby-keyword">return</span> <span class="ruby-ivar">@module</span> <span class="ruby-keyword">if</span> <span class="ruby-ivar">@module</span>
<span class="ruby-keyword">end</span>
<span class="ruby-comment"># go up the hierarchy of names</span>
<span class="ruby-identifier">up</span> = <span class="ruby-identifier">parent</span>.<span class="ruby-identifier">parent</span>
<span class="ruby-keyword">while</span> <span class="ruby-identifier">up</span>
<span class="ruby-identifier">full_name</span> = <span class="ruby-identifier">up</span>.<span class="ruby-identifier">child_name</span>(<span class="ruby-ivar">@name</span>)
<span class="ruby-ivar">@module</span> = <span class="ruby-ivar">@store</span>.<span class="ruby-identifier">modules_hash</span>[<span class="ruby-identifier">full_name</span>]
<span class="ruby-keyword">return</span> <span class="ruby-ivar">@module</span> <span class="ruby-keyword">if</span> <span class="ruby-ivar">@module</span>
<span class="ruby-identifier">up</span> = <span class="ruby-identifier">up</span>.<span class="ruby-identifier">parent</span>
<span class="ruby-keyword">end</span>
<span class="ruby-ivar">@name</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-store-3D" class="method-detail ">
<div class="method-heading">
<span class="method-name">store=</span><span
class="method-args">(store)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Sets the store for this class or module and its contained code objects.</p>
<div class="method-calls-super">
Calls superclass method
<a href="CodeObject.html#method-i-store-3D"><code>RDoc::CodeObject#store=</code></a>
</div>
<div class="method-source-code" id="store-3D-source">
<pre><span class="ruby-comment"># File lib/rdoc/mixin.rb, line 110</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">store=</span> <span class="ruby-identifier">store</span>
<span class="ruby-keyword">super</span>
<span class="ruby-ivar">@file</span> = <span class="ruby-ivar">@store</span>.<span class="ruby-identifier">add_file</span> <span class="ruby-ivar">@file</span>.<span class="ruby-identifier">full_name</span> <span class="ruby-keyword">if</span> <span class="ruby-ivar">@file</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
</section>
</section>
</main>
<footer id="validator-badges" role="contentinfo">
<p><a href="https://validator.w3.org/check/referer">Validate</a>
<p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.2.1.1.
<p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
</footer>